Vcenter NamespaceManagement Networks Edges Foundation DistributedPortGroupNetwork

Vcenter NamespaceManagement Networks Edges Foundation DistributedPortGroupNetwork is a network backed by a single vSphere distributed port group.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "name": "string",
    "network": "string",
    "ipam": "string",
    "ip_config": {
        "ip_ranges": [
            {
                "address": "string",
                "count": 0
            }
        ],
        "gateway": "string"
    }
}

string

name

Required

The user-facing name of the network. A Supervisor workload network will be created with this name. This name must be compliant with DNS naming specifications as stated in RFC 1123.

This property was added in vSphere API 9.0.0.0.

string

network

Required

Distributed Virtual Port Group identifier.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: vSphereDistributedPortGroup. When operations return a value of this schema as a response, the property will be an identifier for the resource type: vSphereDistributedPortGroup.

string

ipam

Required

IP Address management scheme for this network.

For more information see: Vcenter NamespaceManagement Networks Edges Foundation DistributedPortGroupNetwork IPAMType.

This property was added in vSphere API 9.0.0.0.

ip_config

Optional

Configuration used to configure static IP addresses.

This property was added in vSphere API 9.0.0.0.

This property is optional and it is only relevant when the value of ipam is Vcenter NamespaceManagement Networks Edges Foundation DistributedPortGroupNetwork IPAMType.STATIC.